From: Joey Hess <joeyh@joeyh.name>
Date: Fri, 11 Apr 2025 15:17:09 +0000 (-0400)
Subject: improve comment
X-Git-Tag: archive/raspbian/10.20250416-2+rpi1~1^2~6^2~17
X-Git-Url: https://dgit.raspbian.org/%22http://www.example.com/cgi/%22/%22http:/www.example.com/cgi/%22?a=commitdiff_plain;h=d416107c7d7616ced898d179ba972f0b20bd7685;p=git-annex.git

improve comment
---

diff --git a/Types/Remote.hs b/Types/Remote.hs
index 1c9920c0c4..4c2577aa21 100644
--- a/Types/Remote.hs
+++ b/Types/Remote.hs
@@ -89,6 +89,8 @@ data RemoteA a = Remote
 	-- Remotes have a use cost; higher is more expensive
 	, cost :: Cost
 	-- Transfers a key's contents from disk to the remote.
+	-- The optional OsPath is the location of the key's object file.
+	-- When not provided, uses the annex object file.
 	-- The key should not appear to be present on the remote until
 	-- all of its contents have been transferred.
 	-- Throws exception on failure.